<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="IE=edge,chrome=1" charset="utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>BE.log</title>
        <link rel="stylesheet" href="../css/default.css" type="text/css" media="screen, projection">
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/Array.html">Array</a></li>
	
	<li><a href="../symbols/BE.html">BE</a></li>
	
	<li><a href="../symbols/BE.comp.html">BE.comp</a></li>
	
	<li><a href="../symbols/BE.ERROR.html">BE.ERROR</a></li>
	
	<li><a href="../symbols/BE.layer.html">BE.layer</a></li>
	
	<li><a href="../symbols/BE.log.html">BE.log</a></li>
	
	<li><a href="../symbols/BE.proj.html">BE.proj</a></li>
	
	<li><a href="../symbols/BE.time.html">BE.time</a></li>
	
	<li><a href="../symbols/BE.ui.html">BE.ui</a></li>
	
	<li><a href="../symbols/BE.ui.viewsConstructor.html">BE.ui.viewsConstructor</a></li>
	
	<li><a href="../symbols/BE.util.SettingsManager.html">BE.util.SettingsManager</a></li>
	
	<li><a href="../symbols/String.html">String</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace BE.log
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_collinbrooks_Dropbox_Scripts_AEScripts_BeforeEffects_src_beforeeffects.jsx.html">beforeeffects.jsx</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class BE.log.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/BE.log.html#constructor">BE.log</a></b>
							</div>
							<div class="description">Contains methods that help with debugging a script</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class BE.log.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &lt;constant&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								BE.log.<b><a href="../symbols/BE.log.html#.types">types</a></b>
								</div>
								<div class="description">Log message type contstants.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class BE.log.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.log.<b><a href="../symbols/BE.log.html#.debug">debug</a></b>(message)
								</div>
								<div class="description">Outputs an info message to the ExtendScript Toolkit console.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.log.<b><a href="../symbols/BE.log.html#.error">error</a></b>(e)
								</div>
								<div class="description">Outputs an error message to the ExtendScript Toolkit console.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.log.<b><a href="../symbols/BE.log.html#.insertLogStart">insertLogStart</a></b>(s)
								</div>
								<div class="description">Enters in a header message that visibly separates logs written by a
specified script.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.log.<b><a href="../symbols/BE.log.html#.separate">separate</a></b>(padding, s, n)
								</div>
								<div class="description">Inserts a horizontal rule in the log to visually separate the info to be
written to the log.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.log.<b><a href="../symbols/BE.log.html#.warn">warn</a></b>(message)
								</div>
								<div class="description">Outputs a warning message to the ExtendScript Toolkit console.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">BE.log.<b><a href="../symbols/BE.log.html#.write">write</a></b>(type, message)
								</div>
								<div class="description">Writes a message out to the ExtendScript console.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>BE.log</b>
				</div>
				
				<div class="description">
					Contains methods that help with debugging a script
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name=".types"> </a>
					<div class="fixedFont">&lt;static&gt; &lt;constant&gt; 
					
					
					<span class="light">BE.log.</span><b>types</b>
					
					</div>
					<div class="description">
						Log message type contstants. Values:
<ul>
<li>EXCEPTION</li>
<li>WARN</li>
<li>DEBUG</li>
</ul>
						
						
					</div>
					
					

						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
							<dd><a href="../symbols/BE.log.html">BE.log</a></dd>
							
							</dl>
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".debug"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.log.</span><b>debug</b>(message)
					
					</div>
					<div class="description">
						Outputs an info message to the ExtendScript Toolkit console.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>message</b>
									
								</dt>
								<dd>The message to display.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".error"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.log.</span><b>error</b>(e)
					
					</div>
					<div class="description">
						Outputs an error message to the ExtendScript Toolkit console.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Error}</span> <b>e</b>
									
								</dt>
								<dd>The error to output.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".insertLogStart"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.log.</span><b>insertLogStart</b>(s)
					
					</div>
					<div class="description">
						Enters in a header message that visibly separates logs written by a
specified script.
						
						
					</div>
					
					
					
					<pre class="code">     BE.log.insertLogStart('myfilename.jsx');
     //Ouput:
     ----------------
     myfilename.jsx
     <CURRENT DATE HERE>
     ----------------</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>s</b>
									
								</dt>
								<dd>The name of the script to mention in the log start</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd>Nothing.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".separate"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.log.</span><b>separate</b>(padding, s, n)
					
					</div>
					<div class="description">
						Inserts a horizontal rule in the log to visually separate the info to be
written to the log.
						
						
					</div>
					
					
					
					<pre class="code"> BE.log.separate(1, '+', 5);
 //Output:
 
 +++++</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>|Int}</span> <b>padding</b>
									<i>Optional, Default:  0</i>
								</dt>
								<dd><p>One of two types of values can be
sent as the parameter for this method. If you pass an Integer or a
single value Array, that many lines will be added before and after the
separator.</p>

<p>If you pass a two value Array, i.e. [1,2], the Integer at position 0
is used to determine how many blank lines to place above the separator
and the Integer at position [1] is used to determine how many blank
lines to place below the separator.</p>

<p>If the Array sent has a length greater than 2, only the first two
indices are used.</p></dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>s</b>
									<i>Optional, Default: "-"</i>
								</dt>
								<dd>The character to use as the separator.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>n</b>
									<i>Optional, Default:  15</i>
								</dt>
								<dd>How many characters to place within the
horizontal separator line.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".warn"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.log.</span><b>warn</b>(message)
					
					</div>
					<div class="description">
						Outputs a warning message to the ExtendScript Toolkit console.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>message</b>
									
								</dt>
								<dd>The message to display</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".write"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">BE.log.</span><b>write</b>(type, message)
					
					</div>
					<div class="description">
						Writes a message out to the ExtendScript console. The individual
<code>BE.log.debug</code>, <code>BE.log.warn</code> and
<code>BE.log.error</code> can be used as short forms for the
functionality of this method.
						
						
					</div>
					
					
					
					<pre class="code">
BE.log.write(BE.log.types.DEBUG, 'This is a debug message');</pre>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/BE.log.html#.types">BE.log.types</a>}</span> <b>type</b>
									
								</dt>
								<dd>The <code>BE.log.type</code> to use for this
log message</dd>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>message</b>
									
								</dt>
								<dd>The message to log</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			&copy;2010<br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sun May 22 2011 22:54:53 GMT-0500 (CDT)
		</div>
	</body>
</html>
